home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / rabir110.zip / RABIRTH.DOC < prev    next >
Text File  |  1991-11-29  |  11KB  |  306 lines
  1.  
  2.   ╔════════════════════════════════════════════════════════════════════════╗
  3.   ║░░░░░ RABIRTH ░░░░░ For RemoteAccess 1.10 ░░░░░░░░░░ Documentation ░░░░░║
  4.   ╚════════════════════════════════════════════════════════════════════════╝
  5.  
  6. Introduction
  7. ════════════
  8.  
  9. RABIRTH is a utility for RemoteAccess 1.00 and later (including 1.10). RABIRTH 
  10. does a number of things with a user's BIRTHDATE field in the user record.
  11.  
  12. Features of RABIRTH
  13. ═══════════════════
  14.  
  15.         ■ ANS/ASC/AVT List of all users and their birthdays
  16.         ■ ANS/ASC/AVT List of all users having birthdays this month
  17.         ■ ANS/ASC/AVT List of users with birthdays today/tomorrow/yesterday
  18.  
  19.         ■ Post messages to users on their birthdays using a template
  20.           file with $macros.
  21.         ■ Message base locking for multinode systems.
  22.  
  23.         ■ Full handle support, on messages and bulletin screens
  24.         ■ Log for sysop of birthdays today, messages posted, errors
  25.         ■ Opus or FrontDoor log
  26.         ■ Support for hidden users
  27.  
  28.         ■ Configuration of most parameters
  29.  
  30. RABIRTH has been tested with RemoteAccess 1.01 and RemoteAccess 1.10.
  31.  
  32. Configuration of RABIRTH
  33. ════════════════════════
  34.  
  35. RABIRTH is configured by a standard text file (called RABIRTH.CFG) which you 
  36. must create with your favourite text editor (a sample is supplied).
  37.  
  38. The fields in RABIRTH.CFG are described below.
  39.  
  40. Line 1:         Name of sysop for registration and message purposes
  41.                 eg Hamish Moffatt
  42. Line 2:         Name of sysop to use on messages (or blank to use the sysop's
  43.                 real name). eg Hamster
  44.  
  45. Line 3:         Path to users file and message base, ie D:\RA
  46.  
  47. Line 4:         Path and filename of ASC list of users and birthdays.
  48.                 Include extension. Leave a blank line if you do not with to
  49.                 have this bulletin created. eg BDAYLIST.ASC
  50. Line 5:         Path and filename of ANS list of users and birthdays.
  51.                 Include extension. Leave a blank line if you do not with to
  52.                 have this bulletin created. eg BDAYLIST.ANS
  53. Line 6:         Path and filename of AVT list of users and birthdays.
  54.                 Include extension. Leave a blank line if you do not with to
  55.                 have this bulletin created. eg BDAYLIST.ANS
  56.  
  57.  
  58.  
  59.         RABIRTH Documentation                                   Page 1
  60.  
  61.  
  62.  
  63. Line 7:         Path and filename of AVT list of users with birthdays today,
  64.                 tomorrow, and yesterday. Include extension. Leave a blank line
  65.                 if you do not want this bulletin.
  66. Line 8:         Path and filename of ANS list of users with birthdays today,
  67.                 tomorrow, and yesterday. Include extension. Leave a blank line
  68.                 if you do not want this bulletin.
  69. Line 9:         Path and filename of AVT list of users with birthdays today,
  70.                 tomorrow, and yesterday. Include extension. Leave a blank line
  71.                 if you do not want this bulletin.
  72.  
  73. Line 10:        Path and filename of ASC list of users with birthdays during
  74.                 this month. Include extension, and leave a blank line if you
  75.                 do not want this bulletin.
  76. Line 11:        Path and filename of ANS list of users with birthdays during
  77.                 this month. Include extension, and leave a blank line if you
  78.                 do not want this bulletin.
  79. Line 12:        Path and filename of AVT list of users with birthdays during
  80.                 this month. Include extension, and leave a blank line if you
  81.                 do not want this bulletin.
  82.  
  83. Line 13:        Filename of log to write to, usually your RemoteAccess log.
  84.  
  85. Line 14:        Registration number for RABIRTH, or 0 if you haven't 
  86.                 registered yet.
  87.  
  88. Line 15:        Control word. This is a series of 1s and 0s which control
  89.                 the operation of RABIRTH. Except where noted, 1 means yes
  90.                 or on, and 0 means no or off.
  91.  
  92.                 Byte 1: Include yesterday's birthdays in 
  93.                         today/tomorrow/yesterday's screens?
  94.                 Byte 2: Include tomorrow's birthdays in
  95.                         today/tomorrow/yesterday's screens?
  96.                 Byte 3: Include years in month and full lists?
  97.                 Byte 4: Use month names (ie January) instead of month numbers
  98.                         (ie 1)?
  99.                 Byte 5: Multinode? SHARE is required for locking in a 
  100.                         multinode environment sucessfully.
  101.                 Byte 6: FrontDoor (1) or Opus (0) log?
  102.                 Byte 7: Use handles in message headers?
  103.                 Byte 8: Use handles in lists (bulletins)?
  104.  
  105. Line 16:        Board number to post messages to users in. 1-200 only!
  106. Line 17:        Filename of template containing message text to post to users.
  107.                 See "Message template macros" below.
  108.  
  109. Message Template Macros
  110. ═══════════════════════
  111.  
  112. RABIRTH supports several $macros (or $metastrings) in the message template 
  113. file. These are as follows.
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.         RABIRTH Documentation                                   Page 2
  121.  
  122.  
  123.  
  124.         Macro           Translates to           Eg
  125.         ══════════════════════════════════════════════════════════
  126.         $name           user's full name        Hamish Moffatt
  127.         $first          user's first name       Hamish
  128.         $last           user's other names      Moffatt
  129.         $handle         user's handle if set    Hamster
  130.  
  131.         $dayname        name of day of week     Friday
  132.         $monthname      name of month           October
  133.         $day            day of month            11
  134.         $dayth          day with suffix         11th
  135.         $month          month of year           10
  136.         $year           year                    1991
  137.         $birthyear      year of user's birth    1976
  138.         $age            age of user             14
  139.         $ageth          age with suffix         14th
  140.  
  141. Example:
  142.  
  143. Hello $handle!
  144.  
  145. It has come to attention that today, $dayname, $monthname $day, $year, is your
  146. $birthyear birthday!
  147.  
  148. Happy Birthday from the users of Cloud Nine!
  149.  
  150. Regards,
  151. Hamish Moffatt
  152.  
  153. This would translate to something like:
  154.  
  155. Hello Hamster!
  156.  
  157. It has come to attention that today, Friday, October 11, 1991, is your 
  158. 14th birthday!
  159.  
  160. Happy Birthday from the users of Cloud Nine!
  161.  
  162. Regards,
  163. Hamish Moffatt
  164.  
  165.  
  166. Running RABIRTH
  167. ═══════════════
  168.  
  169. RABIRTH requires no command line parameters, and will ignore any passed to it. 
  170. When RABIRTH is run (by typing RABIRTH, or running from a batch file), it will 
  171. display something like the following.
  172.  
  173. ■ RABirth 1.10 for RemoteAccess 1.10
  174. ■ Written by Hamish Moffatt of 3:635/552@fidonet
  175.  
  176. ■ Reading configuration file (RABIRTH.CFG)
  177. ■ Working...
  178.  
  179.  
  180.  
  181.         RABIRTH Documentation                                   Page 3
  182.  
  183.  
  184.  
  185. ■ 0 user(s) have birthdays today
  186. ■ 1 user(s) have birthdays tomorrow
  187. ■ 2 user(s) had  birthdays yesterday
  188.  
  189. ■ Thanks for registering!
  190. ■ Done
  191.  
  192. Legal section (do not stop reading here!)
  193. ═════════════
  194.  
  195. RABIRTH is not freeware or public domain, but shareware. After a reasonable 
  196. trial period (14 days suggested), you are expected to register your copy of 
  197. RABIRTH with the author. See the "Registration" section.
  198.  
  199. RABIRTH is (c) 1991 Hamish Moffatt, All rights reserved.
  200.  
  201. Use in commercial environment without registration is prohibited after the 
  202. trial period!
  203.  
  204.  
  205. Registration of RABIRTH
  206. ═══════════════════════════════════
  207.  
  208.     Registration type                  ║ Price (Australian dollars)
  209.     ═══════════════════════════════════╬═══════════════════════════
  210.     Non-commercial environment         ║ $ 8.00
  211.     Commercial environment             ║
  212.          First copy                    ║ $15.00
  213.          Subsequent copies             ║ $ 5.00
  214.     ═══════════════════════════════════╩═══════════════════════════
  215.  
  216. Please print out and complete the registration form found in the file
  217. REGISTER.DOC, and post to the address found in "Contacting the author".
  218.  
  219. When unregistered, messages posted to users by RABIRTH have this tearline
  220. on the end (eg):
  221.  
  222. --- RABIRTH 1.10 Unregistered
  223.  
  224. When registered, RABIRTH will not insert this line, but instead a ^aPID line
  225. (eg: ^aPID: RABIRTH 1.1). Your users will not know the message is from a
  226. robot once registered!
  227.  
  228.  
  229. Feedback, bug reports, suggestions
  230. ═══════════════════════════════════
  231.  
  232. Feedback, bug reports and suggestions are most welcome, particularly 
  233. suggestions. Please post to any of the addresses in the following section.
  234.  
  235. Contacting the author
  236. ═══════════════════════════════════
  237.  
  238. The author of RABIRTH is Hamish Moffatt.
  239.  
  240.  
  241.  
  242.         RABIRTH Documentation                                   Page 4
  243.  
  244.  
  245.  
  246.  
  247. You can contact me at :     3:635/552@fidonet 
  248.                            9:1390/304@guru.ftn
  249.                            13:100/600@thundernet
  250.                           199:4242/10@rainbownet
  251.  
  252.                           Moffsoft Support HQ
  253.                           Cloud Nine
  254.                           +61-3-803-1326
  255.                           2230-0600 daily (UTC+10 (Melbourne) Time)
  256.  
  257. Alternatively, you can reach me on internet as hamish@phoenix.pub.uu.oz.au.
  258.  
  259. Postal address:                 Hamish Moffatt
  260.                             c/- David Moffatt
  261.                                 ANZ Bank,
  262.                                 9/55 Collins Street,
  263.                                 Melbourne, Victoria,
  264.                                 Australia, 3000.
  265.  
  266.  
  267. OR!                             Moffsoft Support Canberra, Australia!
  268.  
  269.                                 Dynamite BBS
  270.                                 +61-6-241-7388 (2 line)
  271.                                 Harry Konstantinou
  272.                                 Fidonet 3:620/250
  273.  
  274. Credits and Thank yous
  275. ═══════════════════════════════════
  276.  
  277.         ■ RemoteAccess          Andrew Milner and Continental Software
  278.         ■ Turbo Pascal 5.5      Borland International
  279.  
  280.         ■ Logging routines      Hamish Moffatt
  281.         ■ Message base routines P.J.Muller
  282.         ■ Sorting routines      Jim Savold
  283.  
  284.         ■ The RABIRTH 1.10 beta team:
  285.  
  286.                 Hamish Moffatt     3:635/552,
  287.                 Harry Konstantinou 3:620/250,
  288.                 Eugene Mok         3:633/160, and
  289.                 John Marsden       3:633/364     
  290.  
  291.  
  292. The end
  293. ═══════════════════════════════════
  294.         
  295. You're still here? Well you can go configure RABIRTH now, then fill out the 
  296. registration form and post it to me with your cheque :-)
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.         RABIRTH Documentation                                   Page 5
  305.  
  306.